home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 12 / BBS in a box XII-1.iso / Files / Tele / Internet / TurboGopher 1.0.5.sit / TurboGopher 1.0.5 / TurboGopher Docs < prev    next >
Encoding:
Text File  |  1993-04-01  |  6.9 KB  |  156 lines  |  [TEXT/ttxt]
  1. Inside TurboGopher.
  2. -------------------
  3.  
  4. This short document describes features of TurboGopher that either
  5. network administrators or Gopher weenies would want to know.
  6.  
  7.  
  8. Waking up TurboGopher.
  9. ---------------------
  10. When TurboGopher starts up, it looks for the TurboGopher Settings
  11. file first in its own folder, and failing that in the Preferences
  12. folder. If it finds the TurboGopher Settings file, it uses the
  13. settings and resources (more on this later) it finds inside.  If it
  14. cannot find the file, it creates a new one in the Preferences folder
  15. based on its internal defaults (more on this later too).  If there
  16. are any bookmarks the user had set in the Bookmarks worksheet window,
  17. the Bookmark worksheet window is opened.  If the user had deleted all
  18. bookmarks, the Bookmarks window is not opened (the contents of the
  19. Bookmark worksheet window are remembered via the Settings file).
  20.  
  21. Next TurboGopher looks to see if the user has launched it by
  22. double-clicking on a Bookmark file (or by dropping a Bookmark file on
  23. it under System 7).   If this is so, the contents of the Bookmark
  24. file (more on format later) are read and placed in a list (directory)
  25. window; in this case TurboGopher will not make a connection
  26. immediately to the Home Gopher Server.
  27.  
  28. If TurboGopher was launched directly (not via a Bookmarks document)
  29. then it connects to the Home Gopher Server, retrieves the contents of
  30. its top directory, and places this in a list (directory) window. At
  31. this point, TurboGopher is fully up and running.  Next we need to
  32. describe the various parts alluded to above.
  33.  
  34.  
  35. The Home Gopher Servers
  36. -----------------------
  37. Out of the box, TurboGopher comes preconfigured to connect AT RANDOM
  38. to one of the two primary gopher clones (gopher.tc.umn.edu or
  39. gopher2.tc.umn.edu; the former is also known to old Gopher folks as
  40. gopher.micro.umn.edu) at the University of Minnesota.  It must be
  41. emphasized that these are NOT a primary and secondary server: they
  42. contain exactly the same information and changes made to one are
  43. automatically propagated to the other.  If the first connection
  44. attempt fails, TurboGopher will try the next.  This has two purposes.
  45. First, initial connections are very reliable for users and since we
  46. serve as the world's Gophermeisters, this is good.  More importantly
  47. for us, the randomization ensures that users will spread the load
  48. over our two small, economical, primary servers (Mac IIci's). If your
  49. campus' primary Gopher server experiences heavy use, we suggest you
  50. make a clone too.
  51.  
  52. The user may of course reconfigure for only one primary server. 
  53. TurboGopher remembers this via the Settings file.  A campus network
  54. administrator may directly set TurboGopher's internal primary server
  55. defaults by altering STR# ID 3002 using ResEdit.  The first 3 strings
  56. are for one alternate server, the next 3 are for the other.  Leaving
  57. one or the other triplet empty implies that no clone servers are
  58. available.  The first string in the triplet is the server's domain
  59. name, the second is the port, the third denotes whether it is a
  60. Gopher+ server (ignore this for now).
  61.  
  62.  
  63. Other Built-in Information
  64. --------------------------
  65.  
  66. A campus network administrator may also change the default bookmark
  67. set that TurboGopher carries around with him.  This is stored in a
  68. 'TEXT' resource called 'BookMarks'.  It contains Gopher item
  69. descriptors EXACTLY as they come in off the net, ie:
  70.  
  71. Display-String<TAB>Selector-String<TAB>hostName<TAB>port<CR><LF>
  72.  
  73. NOTE:  Ugly linefeed after the <CR>
  74.  
  75. The built-in manual is stored as 'TEXT' resource called "HeLp". While
  76. you can replace that, we certainly don't encourage you to do so.
  77.  
  78. Finally, most of the important English text for status messages etc.
  79. are stored in STR# resources, The primary one of these is STR#
  80. resource ID 3003.  This is important for international localization
  81. purposes.... but read on.
  82.  
  83.  
  84.  
  85. Bookmark file formats
  86. ---------------------
  87.  
  88. Bookmark files contain just the Gopher item descriptor lines that
  89. a Gopher client would ordinarily retrieve over the net.  Please read
  90. the Internet Gopher protocol document for more information on this.
  91. Gopher bookmark files contain text. The fileType is not 'TEXT'
  92. however, so if you wish to edit one with a word processor or text
  93. editor, you will have to either change its fileType or use a
  94. permissive editor. Each line contains the familiar:
  95.  
  96. Display-String<TAB>Selector-String<TAB>hostName<TAB>port<CR>
  97.  
  98. NOTE:  This is Mac text... SO NO LINEFEEDS AFTER THE <CR>
  99.  
  100. Bookmark files have the type 'BKMK' and creator 'MDDF'. The Import
  101. Bookmarks menu item allows you to ATTEMPT to read any filetype you
  102. want and treat it as a Bookmark file.  Please use this with caution. 
  103. While TurboGopher will attempt to make sense out of the file, and
  104. will reject most junk files, you definitely are on thin ice here. 
  105. The Open Gopher Bookmark File menu item however will only let you
  106. open bonafide Bookmark Files.
  107.  
  108.  
  109. ISO Translation Table
  110. ---------------------
  111.  
  112. The ISO Latin-1 character set translation tables used by TurboGopher 
  113. were kindly supplied by Jean-Pierre Kuypers <Kuypers@sri.ucl.ac.be>,
  114. Pascal Maes <Maes@elec.ucl.ac.be>, and Andre Pirard
  115. <Pirard@VM1.ulg.ac.be> They are stored in taBL resources with ID 1002
  116. and 1002.
  117.  
  118.  
  119. The TurboGopher Settings file
  120. -----------------------------
  121.  
  122. We don't want you mucking around inside the data fork of a Settings
  123. file, so we aren't going to encourage you to do it by spelling out
  124. the format (though anyone with a disk editor and a room temperature
  125. IQ can figure it out).
  126.  
  127. We DO want you mucking around inside the resource fork of the
  128. Settings file though.  When it is created by TurboGopher, the
  129. TurboGopher Settings file has no resource fork.  If you add one by
  130. opening the file with ResEdit, then TurboGopher will place the
  131. Settings file in its resource search path.  This means that if you
  132. want some custom resource to be used by TurboGopher, you may place it
  133. in the resource fork of the Settings file rather than munging around
  134. inside TurboGopher's application resource fork.
  135.  
  136. We would like you to place things like string localizations, custom
  137. code resources, and overridden configuration resources here for your
  138. local users.  This way, you can distribute a localized TurboGopher
  139. Settings file on your campus and you shouldn't have to scramble to
  140. patch the application every time we release a new version.  Certainly
  141. we might add more strings to various STR# resources... but if you 
  142. drop us a line and tell us what you are doing with the resources, we
  143. will inform you before we release any new versions of TurboGopher
  144. that might affect you.
  145.  
  146. We have made provision for TurboGopher to execute external code
  147. resources to do certain tasks.  At this point we're  deciding if we
  148. should adopt some new interface for these code resources or to use
  149. the interface that Mac folks are very familiar with: XCMDs.  We will
  150. probably wind up giving you access to various internal parts of
  151. TurboGopher via XCMDs.
  152.  
  153. This document will be updated as necessary. Feedback or comments can
  154. be sent to the usual place:  gopher@boombox.micro.umn.edu
  155.       
  156.  - The Minnesota Gopher Team.